home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 23 / Amiga Format AFCD23 (Feb 1998, Issue 107).iso / -seriously_amiga- / shareware / programming / mui / mcc_time / docs / english / time_mcc.doc next >
Text File  |  1997-12-06  |  15KB  |  476 lines
  1.  
  2.                       Table of Contents
  3.  
  4.   Copyright                   - Copyright information
  5.   Distribution                - Copying conditions
  6.   Disclaimer                  - Legal Information
  7.   Trademark                   - Trademark information
  8.   Support/Updates             - How to get updates and support
  9.   Author                      - How to reach the author
  10.  
  11.   Description                 - What is Time.mcc?
  12.   Requirements                - Requirements for using Time.mcc
  13.  
  14.   Installation                - How to install Time.mcc
  15.  
  16.   Developer Info              - Information for developers
  17.  
  18.   History                     - Revision history of Time.mcc
  19.   Todo                        - Todo list
  20.   Known problems              - List of known problems
  21.   Acknowledgments             - Acknowledgments
  22.   Please rate                 - Please rate Time.mcc
  23.   Subclasses                  - Subclasses build on Time.mcc
  24.  
  25.  
  26.  
  27. Copyright
  28. ---------
  29.  
  30. This software and its documentation are copyright 1996 by Kai Hofmann. All
  31. rights reserved!
  32.  
  33. - Permission for COMMERCIAL USE is only given by an extra available commercial
  34.   license that must be validated!
  35.   Contact me directly for this license, because it will be individually handed
  36.   out per your needs!
  37.  
  38. - Permission is hereby granted, without written agreement and without license,
  39.   to USE this software and its documentation for any NON-COMMERCIAL purpose,
  40.   provided that the above copyright notice and the following paragraph appear
  41.   in all copies of this software (Non-commercial includes Giftware!).
  42.  
  43.   Please send me a full version of your product at no cost including free
  44.   updates!
  45.   Extra money is welcome (For Bank Account see author - but *ONLY* send in DM
  46.   to this Bank Account!).
  47.  
  48.  
  49.  
  50. Distribution
  51. ------------
  52.  
  53. Permission is hereby granted, without written agreement and without license or
  54. royalty fees, to copy and distribute this software and its documentation for
  55. any purpose, provided that the above copyright notice and the following
  56. paragraphs appear in all copies of this software, to:
  57.  
  58. - All who will distribute this software for free!
  59. - All free accessible INTERNET servers!
  60. - All Aminet® sites
  61. - Fred Fish for his great Amiga-Software-Library
  62. - The German SAAR AG PD-Library
  63. - Angela Schmidt's Meeting Pearls series
  64. - All others who do NOT take more than US$ 5.- for one disk that includes this
  65.   software!
  66.  
  67.  
  68. IMPORTANT NOTE:
  69.  
  70. This package may not be included on any further Aminet CD-ROMs unless authors
  71. contributing their software to the CD-ROM, (without mentioning distribution
  72. "NoCD") are granted a copy of the CD *completely* *free* *of* *charge*.
  73.  
  74. The Meeting Pearls IV CD-ROM demonstrates that a Freebie policy is also
  75. possible with "very-low-budget" CD-ROMs (*), so Aminet should quickly
  76. re-establish the same Freebie policy it used up to Aminet CD 13.
  77.  
  78. (*) Suggested retail price for MP4 is DM 14,95/US$ 12/£ 8.95.
  79.  
  80.  
  81.  
  82. DISCLAIMER
  83. ----------
  84.  
  85. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE
  86. LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDER AND/OR OTHER
  87. PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
  88. EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  89. MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO
  90. THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM
  91. PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
  92. CORRECTION.
  93.  
  94. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY
  95. COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY REDISTRIBUTE THE PROGRAM AS
  96. PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL,
  97. INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
  98. THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED
  99. INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE
  100. PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY
  101. HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
  102.  
  103. THE AUTHOR HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
  104. ENHANCEMENTS, OR MODIFICATIONS.
  105.  
  106.  
  107.  
  108. Trademark
  109. ---------
  110.  
  111. DateLib is a trademark of Kai Hofmann
  112.  
  113. Amiga, AmigaDOS, AmigaGuide and Workbench are registered trademarks of
  114. Amiga International, Inc.
  115. Aminet is a registered trademark of Stefan Ossowskis Schatztruhe GmbH
  116. SAS/C is a registered trademark of SAS Institute Inc.
  117.  
  118. All other trademarked names used herein are used for the purposes of
  119. identification and for the benefit of the trademark holder. No infringement of
  120. trademarks is intended. Trademarks remain the property of the trademark holder.
  121.  
  122.  
  123.  
  124. Support/Updates
  125. ---------------
  126.  
  127. - Updates will be available via Aminet®
  128. - Support will be available via the authors email address and via
  129.   http://home.pages.de/~i07m/amiga/mui/Time.html
  130.  
  131.  
  132.  
  133. Author
  134. ------
  135.  
  136. Kai Hofmann
  137. Arberger Heerstraße 92
  138. 28307 Bremen
  139. Germany
  140.  
  141. Phone: (+49)-(0)421/480780
  142. EMail: i07m@informatik.uni-bremen.de
  143.        i07m@zfn.uni-bremen.de
  144. IRC  : PowerStat@#AmigaGer
  145. WWW  : http://home.pages.de/~i07m/
  146.  
  147.  
  148.  
  149.  
  150. Description
  151. -----------
  152.  
  153. Time is an abstract Custom Class of the Magic User Interface © by Stefan Stuntz.
  154. It's a subclass of notify-class and only usable for developers who want to
  155. build subclasses of Time.mcc!
  156.  
  157. The idea of this class was born during developing my Gregor application.
  158.  
  159. MUI abstract public custom class that allowing easy handling of time. Because
  160. it is abstract it is only usefull for developers working with classes that are
  161. based on Time.mcc (like TimeString.mcc), or those who want to build their own
  162. Time.mcc based classes.
  163.  
  164. Time.mcc features:
  165. - Handles daylight savings time
  166. - Handles time zones
  167. - Supports MUIM_Import and MUIM_Export
  168. - Supports drops of other time objects and time-strings
  169. - The time can be read in hour/minutes/seconds format or as seconds from
  170.   midnight on
  171. - The time range can be restricted
  172. - It's possible to notify a Date.mcc object when the next or previous day
  173.   was reached
  174. - Method to set the current time
  175. - Methods for increasing and decreasing the time
  176. - Method to compare with another time object
  177.  
  178.  
  179.  
  180.  
  181. Requirements
  182. ------------
  183.  
  184. - MUI 3.1 (Version 12)
  185. - date.library
  186.  
  187. - To use the Greek MCC-Install script you need the
  188.   "Greek Workbench" © AC Software
  189.  
  190. - To use the Russian MCC-Install script you need
  191.   "Rusifier" © Dmitry Mikhilov
  192.  
  193.  
  194.  
  195. Installation
  196. ------------
  197.  
  198. Please only install Time.mcc when you are a developer!
  199.  
  200. Use the installer script!
  201. (The Installer must be in your system-path!)
  202.  
  203. If you use an Installer prior to V42 you should set the LANGUAGE Tooltype to
  204. your language. Installer V42 and better automatically use your current locale.
  205.  
  206.  
  207. Please note that the installer-script is very special, because:
  208.  
  209. - It features uninstallation
  210. - It is automated
  211. - It is very flexible
  212. - It is very intelligent (for an installer-script ;-)
  213. - It uses WrapGuide (if present) for the AmigaGuide®
  214.   documentation if running under a pre V39 system.
  215. - It can be reused by (hopefully) all other MUI custom classes, because the
  216.   authors of custom classes need to only change a few things:
  217.  
  218.   * The #copyright variable
  219.   * The #min_os_version and #min_os_revision variables
  220.   * The #min_mui_version and #min_mui_revision variables
  221.   * The #language_mcc and #language_mcp variables
  222.   * The P_CustomExists, P_CustomInstall and P_CustomUninstall procedures
  223.   * The 'APPNAME' tooltype within the MCC-Install icon.
  224.  
  225.  
  226.  
  227. Information for Developers
  228. --------------------------
  229.  
  230. There is no multiple inheritance for Boopsi/MUI for the moment, so we haven't
  231. any chance to create a real Time basis-class. But there is another way to have
  232. the same result (compatibility for all classes that are dealing with time).
  233. The solution is called interface inheritance like it was done with IDL for
  234. CORBA.
  235. Interface inheritance has some advantages and some disadvantages.
  236.  
  237. The advantages are:
  238. - (Pseudo) multiple inheritance
  239. - The same interface for all classes dealing with Time
  240.  
  241. The disadvantages are:
  242. - Every one who wants to subclass Time.mcc must include the code for Time.mcc
  243.   in the new subclass.
  244.   But this can be easier done by using the DateLib and/or the Amiga-OS support
  245.   functions.
  246.   Btw. the same happens for IDL, but by using C++ it is possible to inherite
  247.   the implementation.
  248.   A future release of Time.mcc will include a full skeleton C code, so that
  249.   everyone can start his subclasses on this.
  250.  
  251.  
  252. Please note, that you can not compile Time.mcc!
  253. This is because I don't want to distribute the folowing files at the moment:
  254. datetime.h, datesys.h, date_pragmas.h
  255. These files are part of my DateLib (TM) project. A new release will be
  256. available in 1997.
  257. Please note that the supplied source is version 12.0!
  258.  
  259.  
  260. Btw. it would be wise to use a
  261.  
  262.  SetAttrs(obj,
  263.             MUIA_Time_Hour,  hour,
  264.             MUIA_Time_Min,   min,
  265.             MUIA_Time_Sec,   sec,
  266.           TAG_DONE
  267.          );
  268.  
  269. instead of single set()'s.
  270.  
  271.  
  272.  
  273.  
  274. History
  275. -------
  276.  
  277. 10.02.1997 -    First release on Aminet
  278. 28.03.1997 -    Second release on Aminet
  279.         * Added MUIA_Time_MidnightSecs for seconds since midnight
  280.         * Added Blitz Basic 2 interface
  281.         * Added Cluster interface
  282.         * Added ARexx interface
  283.         * Added MUIBuilder3 description
  284.         * Added German documentation
  285.         * Added drop support
  286. 14.08.1997 -    Third release on Aminet
  287.         * Added @{AMIGAGUIDE} V40 features to the documentation
  288.         * Added "Please rate" section to the documentation
  289.         * MCC-Install 43.21
  290.         * Added MagicWB readme
  291.         * Compiled with MCCLib 12.2
  292.         * MUIM_Time_Compare
  293.         * Bugfix in MUIM_Time_SetCurrent
  294.         * Optimizations
  295. 07.10.1997 -    Fourth release on Aminet
  296.         * Accept drags with time-strings
  297.         * Compiled with MCCLib 12.4
  298.         * date.library 33.280
  299. 27.11.1997 -    Fifth release on Aminet
  300.         * date.library 33.286
  301.  
  302.  
  303.  
  304. Todo
  305. ----
  306.  
  307. Notify on locale preference change (time zone): env:sys/locale.prefs
  308.  
  309.  
  310.  
  311. Known problems
  312. --------------
  313.  
  314. - Old versions of the program called 'PhoneCost' written by André Schenk
  315.   <schenkae@tick.informatik.uni-stuttgart.de> installed another
  316.   'date.library' into 'Libs:'.
  317.  
  318.  
  319.  
  320. Acknowledgments are going to the following people:
  321.  
  322. Rita Reichl         : for correcting my English and being my inspiration
  323.  
  324. James Cooper,
  325. Steve Krueger,
  326. Doug Walker         : For supporting SAS/C® after SAS suspends the support.
  327.  
  328. Stefan Stuntz       : for the Magic User Interface and for his support
  329. Klaus Melchior      : for the MUI custom class support
  330. Martin Huttenloher  : for MagicWB
  331. Udo Schuermann      : for WrapGuide
  332. Stefan Kost         : for ag2txt
  333. Jürgen Kohrmeyer    : for the rexxtricks.library
  334.  
  335. Henning Thielemann  : for help with the Cluster interface
  336. Eric Gerard         : for his great icons
  337.  
  338.  
  339.  
  340. Please rate
  341. -----------
  342.  
  343. Please rate Time.mcc and MCC-Install. To do so, send an email to
  344. aminet-server@wuarchive.wustl.edu
  345. with the following content:
  346.  
  347. RATE dev/mui/MCC-Install.lha <num>
  348. RATE dev/mui/MCC_Time.lha <num>
  349.  
  350. where <num> is a mark from 0..10 with 10 being the best.
  351. You can rate several programs in one mail.
  352.  
  353. Thank you!
  354.  
  355.  
  356.  
  357. Subclasses
  358. ----------
  359.  
  360. The following classes are build on Time.mcc:
  361.  
  362.  
  363. TimeString.mcc:
  364.    By Kai Hofmann <i07m@informatik.uni-bremen.de>
  365.    http://home.pages.de/~i07m/amiga/mui/TimeString.html
  366.    Aminet:dev/mui/MCC_TimeString.lha
  367.  
  368.  
  369.  
  370.  
  371.                       This is a custom class of the
  372.  
  373.  
  374.                         MUI - MagicUserInterface
  375.  
  376.                  Copyright © 1993-1997 by Stefan Stuntz
  377.  
  378.  
  379. MUI is a system to generate and maintain graphical user interfaces. With
  380. the  aid  of  a  preferences program, the user of an application has the
  381. ability to customize the outfit according to his personal taste.
  382.  
  383. MUI is distributed as shareware. To obtain a complete package containing
  384. lots of examples and more information about registration please look for
  385. a  file  called  "muiXXusr.lha"  (XX means the latest version number) on
  386. your local bulletin boards or on public domain disks.
  387.  
  388.           If you want to register directly, feel free to send
  389.  
  390.  
  391.                          DM 30.-  or  US$ 20.-
  392.  
  393.                                   to
  394.  
  395.                              Stefan Stuntz
  396.                         Eduard-Spranger-Straße 7
  397.                              80935 München
  398.                                 GERMANY
  399.  
  400.  
  401.              Support and online registration are available at
  402.  
  403.                           http://www.sasg.com/
  404.  
  405.  
  406.  
  407.                  This product is based on or uses parts of
  408.  
  409.                      MagicWB - The Workbench Enhancer
  410.                      --------------------------------
  411.  
  412.                  Copyright © 1992-1997, Martin Huttenloher
  413.  
  414. If  you  use  and like this product you should very much consider to take a
  415. look  at  MagicWB,  which  is the authentic source of the style, colors and
  416. design  elements  contained  in  this  package.   It  features  hundreds of
  417. original  icons,  patterns, image-drawers,  dock-brushes and some specially
  418. designed  high-quality  fonts  to  improve the comfort & legibility of your
  419. daily Workbench session.
  420.  
  421. What  is  MagicWB?   MagicWB  is  a full replacement for the Graphical User
  422. Interface  of the Workbench and has become the standard visual interface on
  423. the  Amiga.  Over the last years MagicWB has received various merits and an
  424. overwhelming  response from Amiga magazines and users worldwide proclaiming
  425. it  "a  must  for  all  Amiga  users".   Even  commercial  applications are
  426. supporting the multi-colored look & style of MagicWB.
  427.  
  428. Get yourself the latest version of MagicWB and see for yourself the wonders
  429. it  can  do by automatically transforming your old and dull Amiga Workbench
  430. into  an impressive workstation environment that will be the envy of all PC
  431. Windows  and  Mac users.  Update yourself to the state-of-the-art workbench
  432. standard  everyone uses on the Amiga!  It is also your key to enjoy the new
  433. look & feel of many applications and other MWB add-ons and extensions.
  434.  
  435. MagicWB  is  distributed as shareware.  Get yourself the latest FREE PUBLIC
  436. RELEASE of MagicWB now:  It is called
  437.  
  438.                              ----------------
  439.                               MagicWB21p.lha
  440.                              ----------------
  441.  
  442. and  can  be found everywhere on Aminet (or your local BBS or public domain
  443. series).   Install it and witness the instant magic it performs on your old
  444. Amiga  Workbench.   Also  included  is the latest SASG registration program
  445. with which you can order and get the full registered version of MagicWB.
  446.  
  447.              If you want to order directly, feel free to send
  448.  
  449.                   DM 30.- or US$ 20.- (cash, no checks!)
  450.  
  451.                                     to
  452.  
  453.                             Martin Huttenloher
  454.                              Am Hochstraess 4
  455.                                D-89081 Ulm
  456.                                  Germany
  457.  
  458. You  may  also  choose  to visit the official MagicWB homepage on the world
  459. wide  web.   There you can find the latest news & support and even register
  460. your  MagicWB  online  (which is much more comfortable and faster). You can
  461. even  benefit  from  various  special offers & discounts for MagicWB if you
  462. order through our website!  Come and visit MagicWB at:
  463.  
  464.                           ----------------------
  465.                            http://www.sasg.com/
  466.                           ----------------------
  467.  
  468.               Save 20% by using the discounts on our website!
  469.  
  470.            Ordering online also saves you a lot of time and work!
  471.  
  472.  
  473.  
  474. WrapGuide is Copyright 1994-1995 Udo Schuermann
  475. All rights reserved
  476.